Skip to content

Conversation

dannywillems
Copy link
Member

@dannywillems dannywillems commented Jul 22, 2025

Partially solving https://github.com/o1-labs/openmina/issues/1233

Run make docs-serve locally and enjoy.

The work from @tizoc in https://github.com/o1-labs/openmina/pull/1173 will be integrated, totally or partially.

@dannywillems dannywillems force-pushed the dw/docs-docusaurus branch 16 times, most recently from ea569e8 to 07fc0be Compare July 22, 2025 15:35
@dannywillems dannywillems requested a review from 0xMimir July 22, 2025 15:37
@dannywillems dannywillems force-pushed the dw/docs-docusaurus branch 2 times, most recently from f13c2b4 to 891add7 Compare July 22, 2025 16:15
- Add check-trailing-whitespace Makefile target to detect trailing
  whitespaces in source files
- Add fix-trailing-whitespace Makefile target to automatically remove
  trailing whitespaces
- Create CI workflow to check for trailing whitespaces on all pushes
- Update CLAUDE.md with trailing whitespace removal requirements
- Wrap Makefile target commands to 80 characters for better readability

All file types covered: .rs, .toml, .md, .yaml, .yml, .json, .ts, .tsx,
.js, .jsx with appropriate directory exclusions for build artifacts and
dependencies.
- Create docs.yaml workflow for documentation CI/CD with:
  * Documentation build testing and broken link detection
  * Rust API documentation generation and integration
  * GitHub Pages deployment on develop branch
  * Versioned documentation creation on tag releases

- Update Docusaurus config to include API documentation links
- Add Makefile targets for Rust documentation integration
Applied automatic trailing whitespace removal across the codebase using
the new fix-trailing-whitespace Makefile target. This ensures consistent
formatting and prevents future trailing whitespace commits.

Files affected:
- Rust source files (.rs)
- Configuration files (.toml, .yml, .yaml)
- Documentation files (.md)
- Frontend files (.js, .ts, .tsx)
- Various other project files

This is a formatting-only change with no functional modifications.
Convert all bare URLs to proper hyperlinks by wrapping them with angle
brackets. This resolves the "this URL is not a hyperlink" warnings when
running make docs-rust.

Changes:
- Wrapped all bare URLs in documentation comments with <> brackets
- Fixed URLs in module-level docs (//\!), regular docs (///), and comments (//)
- Processed all .rs files in the workspace excluding build artifacts

All documentation URLs are now properly formatted as clickable hyperlinks
in the generated API documentation.
Copy link
Contributor

@0xMimir 0xMimir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just update storage prerequisites, in getting-started.md


- **Operating System**: Linux (Ubuntu 20.04+, Debian 10+) or macOS
- **Memory**: At least 8GB RAM (16GB recommended for block producers)
- **Storage**: 50GB+ free disk space
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In website/docs/developers/getting-started.mdx it says 20GB

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

20GB of storage is needed for building the node, but just for running I think free storage is irrelevant

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. We should put real numbers with the archive node too. Leaving like this for now until we have real numbers. We will ask @dkijania and @luis when we would have deployed the BP and archive nodes on our servers.

@dannywillems
Copy link
Member Author

For macOS: update the docs with the setup instructions and add it in CI (macos-latest).

Copy link
Contributor

@volhovm volhovm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge this. It compiles and it's a big PR.

We can address the concrete website content changes in separate PRs and it will look cleaner -- now changes are lost in a 20k LOC log :)

@dannywillems dannywillems merged commit f5200db into develop Jul 23, 2025
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants